AWeb ARexx Commands

Program related commands

ADDHOTLIST
ALLOWCMD
BACKGROUND
BGSOUND
CLEARSELECTION
COPYBLOCK
DELETECACHE
DRAGGING
EDITSOURCE
FIXCACHE
FLUSHCACHE

HOTLIST
ICONIFY
IMAGELOADING
INFO
JAVASCRIPT
JSBREAK
JSDEBUG
LOADIMAGES
LOADSETTINGS
MIMETYPE
PLAYBGSOUND

PLUGIN
PRINT
QUIT
REQUEST
REQUESTFILE
REQUESTSTRING
RUN
SAVEAUTHORIZE
SAVESETTINGS
SCREENTOBACK
SCREENTOFRONT

SEARCH
SETCLIP
SETCOOKIES
SNAPSHOT
SUBWINDOW
SYSTEM
URLENCODE
USEPROXY
VIEWSOURCE

ADDHOTLIST

Template:


   ADDHOTLIST URL,TITLE,TARGET/K

Add the current document in the addressed window or in the specified frame, or the supplied URL to the hotlist.

Argument Description
URL The URL to add to the hotlist. If not given, the currently shown URL in the window (or in the specified frame) is added.
TITLE Title to show in the hotlist for the given URL. Ignored if the URL argument is not given.
TARGET The target name of the window or frame showing the document to add to the hotlist. Ignored if the URL argument is supplied.

Argument	Description
URL	The URL to add to the hotlist. If not given, the currently shown URL in the window (or in the specified frame) is added.
TITLE	Title to show in the hotlist for the given URL. Ignored if the URL argument is not given.
TARGET	The target name of the window or frame showing the document to add to the hotlist. Ignored if the URL argument is supplied.

ALLOWCMD

Template:


   ALLOWCMD

Temporarily allow shell commands and ARexx macros to be started from hyperlinks regardless of the Allow shell commands setting. This allows easier usage of ARexx plug-ins without need for the user to explicitly change the settings.

Commands are allowed only in the current document, or in the document that is being loaded. After a new document is loaded in the window, the normal settings apply.

BACKGROUND

Template:


   BACKGROUND ON/S,OFF/S

Control the usage of background images and colours.

Argument Description
ON Use backgrounds.
OFF Don't use backgrounds.
The ON and OFF arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
ON	Use backgrounds.
OFF	Don't use backgrounds.

BGSOUND

Template:


   BGSOUND ON/S,OFF/S

Control the usage of background sounds.

Argument Description
ON Use background sounds.
OFF Don't use background sounds.
The ON and OFF arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
ON	Use background sounds.
OFF	Don't use background sounds.

CLEARSELECTION

Template:


   CLEARSELECTION

Clears the current drag-selection highlight in the addressed window.

COPYBLOCK

Template:


   COPYBLOCK

Copy the currently selected text, if any, to the clipboard.

DELETECACHE

Template:


   DELETECACHE IMAGES/S,DOCUMENTS/S,FORCE/S,PAT=PATTERN/K

Delete files from the cache.

Argument Description
IMAGES Delete images and other non-text files.
DOCUMENTS Delete text files.
FORCE When set, suppress the display of the confirmation requester that is shown when deleting all documents or images.
PATTERN Delete files by URL pattern using standard DOS wildcards. When the pattern does not include a scheme (like http://), the scheme part of each URL is not included in the pattern match. So a pattern "foo.bar#?" matches "http://foo.bar/xyz.html" and "ftp://foo.bar/zoo".
When IMAGES or DOCUMENTS is specified, the delete is restricted to that type of file, otherwise all matching files are deleted.
When PATTERN is not used, at least one of IMAGES and DOCUMENTS must be set, or else this command does nothing.

Argument	Description
IMAGES	Delete images and other non-text files.
DOCUMENTS	Delete text files.
FORCE	When set, suppress the display of the confirmation requester that is shown when deleting all documents or images.
PATTERN	Delete files by URL pattern using standard DOS wildcards. When the pattern does not include a scheme (like `http://`), the scheme part of each URL is not included in the pattern match. So a pattern "foo.bar#?" matches "http://foo.bar/xyz.html" and "ftp://foo.bar/zoo". When `IMAGES` or `DOCUMENTS` is specified, the delete is restricted to that type of file, otherwise all matching files are deleted.

DRAGGING

Template:


   DRAGGING ON/S,OFF/S

Temporarily turns clipboard drag-selecting on or off for the addressed window.

Argument Description
ON Turn drag-selecting on.
OFF Turn drag-selecting off.
The ON and OFF arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
ON	Turn drag-selecting on.
OFF	Turn drag-selecting off.

EDITSOURCE

Template:


   EDITSOURCE URL/A

Start the editor for the source of this URL. If the document is not in memory, this command does nothing.

Argument Description
URL The URL for which to edit the source.

Argument	Description
URL	The URL for which to edit the source.

FIXCACHE

Template:


   FIXCACHE FORCE/S

Start synchronizing the cache contents and registration.

Argument Description
FORCE When set, suppress the display of the confirmation requester.

Argument	Description
FORCE	When set, suppress the display of the confirmation requester.

FLUSHCACHE

Template:


   FLUSHCACHE IMAGES/S,DOCUMENTS/S,ALL/S,URL/K

Remove files from AWeb's memory cache.

Argument Description
IMAGES When set, flush nondisplayed images. If the ALL switch is set, displayed images are also flushed.
DOCUMENTS When set, flush nondisplayed documents.
ALL Used in combination with the IMAGES switch to flush all images instead of only nondisplayed images.
URL When given, this specified URL will be flushed from memory.

Argument	Description
IMAGES	When set, flush nondisplayed images. If the ALL switch is set, displayed images are also flushed.
DOCUMENTS	When set, flush nondisplayed documents.
ALL	Used in combination with the IMAGES switch to flush all images instead of only nondisplayed images.
URL	When given, this specified URL will be flushed from memory.

HOTLIST

Template:


   HOTLIST SET/K,SAVE/S,RESTORE/S

Control or show the hotlist.

Argument Description
SET Name of a stem variable containing an array of structured information describing the new hotlist contents.
See the GET HOTLIST command for a description of the structured information.
SAVE Save the current or new contents of the hotlist to disk.
RESTORE Restore the hotlist to the contents that was last saved to disk.

Argument	Description
SET	Name of a stem variable containing an array of structured information describing the new hotlist contents. See the GET HOTLIST command for a description of the structured information.
SAVE	Save the current or new contents of the hotlist to disk.
RESTORE	Restore the hotlist to the contents that was last saved to disk.

If no argument is given, the hotlist is shown. If the hotlist button gives requester option is on, the hotlist viewer window is opened. Otherwise the hotlist is displayed in the addressed window.

ICONIFY

Template:


   ICONIFY HIDE/S,SHOW/S

Controls iconification of the program.

Argument Description
HIDE When set, the program is iconified to an icon on the Workbench screen.
SHOW When set, the program windows are reopened.
The HIDE and SHOW arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
HIDE	When set, the program is iconified to an icon on the Workbench screen.
SHOW	When set, the program windows are reopened.

IMAGELOADING

Template:


   IMAGELOADING OFF/S,MAPS/S/ALL/S

Controls the loading of inlined images in HTML documents.

Argument Description
OFF When set, no inlined images will be loaded.
MAPS When set, only images representing clickable maps will be loaded.
ALL When set, all inlined images will be loaded.
The OFF, MAPS and ALL arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
OFF	When set, no inlined images will be loaded.
MAPS	When set, only images representing clickable maps will be loaded.
ALL	When set, all inlined images will be loaded.

INFO

Template:


   INFO TARGET/K

Open the information window for the document in the addressed window or in the specified frame.

Argument Description
TARGET The target name of the window or frame to open the information window for.

Argument	Description
TARGET	The target name of the window or frame to open the information window for.

JAVASCRIPT

Template:


   JAVASCRIPT SOURCE,FILE/K,TARGET/K,VAR/K

Run this JavaScript source in the context of the document in the addressed window or in the specified frame. The resulting value from the script is converted to string and returned in the reserved variable RESULT or in the variable with the specified name.

If the user has disabled JavaScript usage, this command does nothing and returns a warning (RC status 5).

Argument Description
SOURCE The JavaScript source to run. It may be a single expression, a statement or a complete program.
FILE The path and name of a local file containing the JavaScript source to run. Either the SOURCE or the FILE argument must be given.
TARGET The target name of the window or frame that defines the context to run the script in.
VAR The name of the ARexx variable to return the result in. By default the result is returned in the reserved variable RESULT.

Argument	Description
SOURCE	The JavaScript source to run. It may be a single expression, a statement or a complete program.
FILE	The path and name of a local file containing the JavaScript source to run. Either the SOURCE or the FILE argument must be given.
TARGET	The target name of the window or frame that defines the context to run the script in.
VAR	The name of the ARexx variable to return the result in. By default the result is returned in the reserved variable RESULT.

JSBREAK

Template:


   JSBREAK

Cancel all outstanding JavaScript timeout events in the addressed window.

JSDEBUG

Template:


   JSDEBUG ON/S,OFF/S

Turns debugging of JavaScripts on or off.

Argument Description
ON Turn debugging of JavaScripts on.
OFF Turn debugging of JavaScripts off.
The ON and OFF arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
ON	Turn debugging of JavaScripts on.
OFF	Turn debugging of JavaScripts off.

LOADIMAGES

Template:


   LOADIMAGES TARGET/K,MAPS/S

Load embedded images in the current HTML document in the addresses window or in the specified frame.

Argument Description
TARGET The target name of the window or frame to load the images in.
MAPS When set, only images representing clickable maps are loaded. Otherwise all embedded images are loaded.

Argument	Description
TARGET	The target name of the window or frame to load the images in.
MAPS	When set, only images representing clickable maps are loaded. Otherwise all embedded images are loaded.

LOADSETTINGS

Template:


   LOADSETTINGS PATH,REQUEST/S

Load a new set of AWeb settings.

Argument Description
PATH The fully qualified name of the drawer where to load the settings from.
AWeb will look for files named browser, program and network.
REQUEST If set, a file requester is displayed where the user can select the settings to load. This command does not wait until the file requester is closed.

Argument	Description
PATH	The fully qualified name of the drawer where to load the settings from. AWeb will look for files named `browser`, `program` and `network`.
REQUEST	If set, a file requester is displayed where the user can select the settings to load. This command does not wait until the file requester is closed.

MIMETYPE

Template:


   MIMETYPE NAME/A

Get the MIME type associated with this file name, based on the file extension. this uses the currently defined MIME types. The MIME type is returned in the reserved variable RESULT. If no MIME type can be found, an empty string is returned.

Argument Description
NAME The file name to find a MIME type for.

Argument	Description
NAME	The file name to find a MIME type for.

PLAYBGSOUND

Template:


   PLAYBGSOUND

Starts or restarts the playing of a background sound in the current document. If the current document has no background sound defined, this command has no effect.

PLUGIN

Template:


   PLUGIN PLUGIN/A,COMMAND/A

Sends a command to an AWeb plugin module, if that plugin module supports commands. The result of the command, if any, is returned in the reserved variable RESULT.

If the plugin isn't yet loaded in memory and you specify the correct path with the plugin name, the plugin will be loaded into memory by the PLUGIN command. Use this facility with care. Unless the plugin is subsequently used by AWeb in the normal fashion, or you remove the library from memory by doing a memory flush, AWeb will not be able to exit because the plugin in memory still has the awebplugin.library in use.

If the plugin cannot be found, or if the plugin does not support commands, a return code 5 is returned.

Argument Description
PLUGIN The name of the AWeb plugin module to address. AWeb plugin modules should not be confused with external ARexx scripts.
COMMAND The command to be sent to the plugin. See the documentation for the specific AWeb plugin for the supported commands.

Argument	Description
PLUGIN	The name of the AWeb plugin module to address. AWeb plugin modules should not be confused with external ARexx scripts.
COMMAND	The command to be sent to the plugin. See the documentation for the specific AWeb plugin for the supported commands.

PRINT

Template:


   PRINT SCALE/N/K,CENTER/S,NOFF=NOFORMFEED/S,NOBG=NOBACKGROUND/S,WAIT/S,REQUEST/S

Make a graphical printout of the current document in the addressed window. If AWeb is still printing another document, a return code 5 is returned.

Argument Description
SCALE The scaling percentage for the printout. Default is 100 percent.
CENTER If this switch is set, the print will be centered on the paper.
NOFORMFEED If this switch is set, there will be no form feed when printing is finished. Default is to add a form feed.
NOBACKGROUND If this switch is set, backgrounds and text colours are not used. Default is to use backgrounds and colours.
WAIT If this switch is set, the command will not return until the printing is finished. Without this switch, the command returns immediately while AWeb continues printing.
REQUEST If set, the print requester is opened where the user can select the print details.
If this switch is set, then all other arguments are ignored.

Argument	Description
SCALE	The scaling percentage for the printout. Default is 100 percent.
CENTER	If this switch is set, the print will be centered on the paper.
NOFORMFEED	If this switch is set, there will be no form feed when printing is finished. Default is to add a form feed.
NOBACKGROUND	If this switch is set, backgrounds and text colours are not used. Default is to use backgrounds and colours.
WAIT	If this switch is set, the command will not return until the printing is finished. Without this switch, the command returns immediately while AWeb continues printing.
REQUEST	If set, the print requester is opened where the user can select the print details. If this switch is set, then all other arguments are ignored.

QUIT

Template:


   QUIT FORCE/S

Terminate AWeb.

Argument Description
FORCE When set, this switch suppresses the "Are you sure" requester.

Argument	Description
FORCE	When set, this switch suppresses the "Are you sure" requester.

REQUEST

Template:


   REQUEST TITLE/A,BODY/A,GADGETS/A,NOWAIT/S

Display a requester on the AWeb screen. Unless NOWAIT is specified, the user's response is returned in the reserved variable RESULT. The result is a number, starting from 1 for the left most button. When the rightmost button is selected, or the requester is cancelled with the Esc key, return code 5 (warning) is set.

Argument Description
TITLE The requester title string.
BODY The body text for the requester. DOS escape characters are supported, i.e. "*N" will begin a new line. To include an empty line, use "*N *N", with a space between the two newlines.
GADGETS A string describing the gadgets. Multiple gadgets must be separated by the vertical bar "|". You can precede a character in each individual gadget label with an underscore to make that character the keyboard shortcut.
NOWAIT When set, the command will not wait for user input. No user response is returned. Really only makes sense for informational requesters with only one choice.

Argument	Description
TITLE	The requester title string.
BODY	The body text for the requester. DOS escape characters are supported, i.e. "`N`" will begin a new line. To include an empty line, use "`N *N`", with a space between the two newlines.
GADGETS	A string describing the gadgets. Multiple gadgets must be separated by the vertical bar "`\|`". You can precede a character in each individual gadget label with an underscore to make that character the keyboard shortcut.
NOWAIT	When set, the command will not wait for user input. No user response is returned. Really only makes sense for informational requesters with only one choice.

REQUESTFILE

Template:


   REQUESTFILE TITLE/A,FILE/K,PATTERN/K,SAVEMODE/S,DIRSONLY/S

Display a standard file requester on the AWeb screen. The selected file name is returned in the reserved variable RESULT. When the requester is cancelled by the user, the return code 5 (warning) is set.

Argument Description
TITLE The requester title string.
FILE Initial path and/or file name. If you want to supply a directory without filename, then end the path with a slash.
PATTERN If supplied, the requester will contain a pattern gadget with this initial contents.
SAVEMODE Turn the requester into a save mode requester.
DIRSONLY Restrict the operation of the requester to only directories, not file names.

Argument	Description
TITLE	The requester title string.
FILE	Initial path and/or file name. If you want to supply a directory without filename, then end the path with a slash.
PATTERN	If supplied, the requester will contain a pattern gadget with this initial contents.
SAVEMODE	Turn the requester into a save mode requester.
DIRSONLY	Restrict the operation of the requester to only directories, not file names.

REQUESTSTRING

Template:


   REQUESTSTRING TITLE/A,BODY/A,GADGETS/A,DEFAULT

Display a requester on the AWeb screen where the user can type in a string. The user's response is returned in the reserved variable RESULT. The result is a number, starting from 1 for the left most button. When the rightmost button is selected, or the requester is cancelled with the Esc key, return code 5 (warning) is set.

Argument Description
TITLE The requester title string.
BODY The body text for the requester. DOS escape characters are supported, i.e. "*N" will begin a new line. To include an empty line, use "*N *N", with a space between the two newlines.
GADGETS A string describing the gadgets. Multiple gadgets must be separated by the vertical bar "|". You can precede a character in each individual gadget label with an underscore to make that character the keyboard shortcut.
DEFAULT The default string to display initially in the string gadget of the requester.

Argument	Description
TITLE	The requester title string.
BODY	The body text for the requester. DOS escape characters are supported, i.e. "`N`" will begin a new line. To include an empty line, use "`N *N`", with a space between the two newlines.
GADGETS	A string describing the gadgets. Multiple gadgets must be separated by the vertical bar "`\|`". You can precede a character in each individual gadget label with an underscore to make that character the keyboard shortcut.
DEFAULT	The default string to display initially in the string gadget of the requester.

RUN

Template:


   RUN NAME/A/F

Start an ARexx macro.

Argument Description
NAME Path and name of the ARexx macro to start, with optional arguments.

Argument	Description
NAME	Path and name of the ARexx macro to start, with optional arguments.

SAVEAUTHORIZE

Template:


   SAVEAUTHORIZE

Saves the authorization details now. Usually these details are saved when you quit AWeb, if they are changed.

SAVESETTINGS

Template:


   SAVESETTINGS PATH,REQUEST/S

Save the current settings to the current configuration drawer, or another drawer.

Argument Description
PATH The fully qualified name of the drawer where to save the settings. If none is given, the settings will be saved on top of the current settings (either default or as indicated by the CONFIG tooltype or argument.
REQUEST If set, a file requester is displayed where the user can select the settings to save.

Argument	Description
PATH	The fully qualified name of the drawer where to save the settings. If none is given, the settings will be saved on top of the current settings (either default or as indicated by the CONFIG tooltype or argument.
REQUEST	If set, a file requester is displayed where the user can select the settings to save.

SCREENTOBACK

Template:


   SCREENTOBACK

Move the screen that AWeb is using to the back of all other screens.

SCREENTOFRONT

Template:


   SCREENTOFRONT

Move the screen that AWeb is using in front of all other screens.

SEARCH

Template:


   SEARCH TARGET/K

Open the search requester for the document in the addressed window or in the specified frame.

Argument Description
TARGET The target name of the window or frame to open the search requester for.

Argument	Description
TARGET	The target name of the window or frame to open the search requester for.

SETCLIP

Template:


   SETCLIP VALUE/A/F

Copy a string to the clipboard.

Argument Description
VALUE The string to copy to the clipboard.

Argument	Description
VALUE	The string to copy to the clipboard.

SETCOOKIES

Template:


   SETCOOKIES STEM/A/K,ADD/S

Add or replace cookies known by AWeb.

Argument Description
STEM The name of a stem variable that holds the cookie information. See the GET COOKIES command for a description of the contents of this array.
The NAME, VALUE, DOMAIN and PATH items must be given for each cookie, the other items are optional.
ADD If set, the cookies will be added to the cookies already known by AWeb.
If not set, the new cookies will replace all known cookies.

Argument	Description
STEM	The name of a stem variable that holds the cookie information. See the GET COOKIES command for a description of the contents of this array. The NAME, VALUE, DOMAIN and PATH items must be given for each cookie, the other items are optional.
ADD	If set, the cookies will be added to the cookies already known by AWeb. If not set, the new cookies will replace all known cookies.

SNAPSHOT

Template:


   SNAPSHOT

Save the current window positions and locations.

SUBWINDOW

Template:


   SUBWINDOW TYPE/A,OPEN/S,CLOSE/S

Open or close one of AWeb's subwindows.

Argument Description
TYPE Name of the window. Valid names are:

ABOUT About window
AUTHORIZE Authorizations edit window
CACHEBROWSER Cachebrowser window
HISTORY History window
HOTMANAGER Hotlist manager
HOTVIEWER Hotlist viewer
NETSTATUS Network status window

OPEN If this switch is set, the window is opened, or moved to front and made active if it was already open.
CLOSE If this switch is set, the window is closed if it was open.

SYSTEM

Template:


   SYSTEM COMMAND/A,ARGUMENTS/F

Spawn a CLI command.

Argument Description
COMMAND The command to start.
ARGUMENTS Arguments for the command.

Argument	Description
COMMAND	The command to start.
ARGUMENTS	Arguments for the command.

URLENCODE

Template:


   URLENCODE STRING/A,VAR/K

Encode the string using the URL-encode mechanism. Spaces are replaced by '+', most non-alphanumeric characters are escaped. The result is returned in the reserved variable RESULT, or in the given variable name.

Argument Description
STRING The string to URL-encode.
VAR The name of a variable to return the information in. If no name is specified, the result will be returned in the reserved ARexx variable RESULT.

Argument	Description
STRING	The string to URL-encode.
VAR	The name of a variable to return the information in. If no name is specified, the result will be returned in the reserved ARexx variable `RESULT`.

USEPROXY

Template:


   USEPROXY ENABLE/S,DISABLE/S

Controls the usage of proxies for transfers started in this window.

Argument Description
ENABLE Enables the use of proxies.
DISABLE Disables the use of proxies.
The ENABLE and DISABLE arguments are mutually exclusive. When neither one is specified, the setting is toggled.

Argument	Description
ENABLE	Enables the use of proxies.
DISABLE	Disables the use of proxies.

VIEWSOURCE

Template:


   VIEWSOURCE URL/A

Start the HTML source viewer for the source of this URL. If the document is not in memory, this command does nothing.

Argument Description
URL The URL for which to view the source.